[WIP] Document jobconfig file #56
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update .gitignore
- Remove trailing spaces - Wrap long lines - A couple minor markdown syntax fixes
4 tasks
Documents scicat-backend-next#1463
- Document ValidateAction changes (#1473) - Convert examples to YAML (#1463)
4 tasks
despadam
reviewed
Jan 8, 2025
Comment on lines
297
to
322
| - RABBITMQ\_ENABLED: | ||
| Flag to enable/disable RabbitMQ consumer. | ||
| accepted values: "yes", "no" | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no | ||
| _format_: string | ||
|
|
||
| - RABBITMQ\_HOSTNAME: | ||
| The hostname of the RabbitMQ message broker. Only required if RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _default_: string | ||
|
|
||
| - RABBITMQ\_USERNAME: | ||
| The username used to authenticate to the RabbitMQ message broker. Only required if | ||
| RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _format_: string | ||
|
|
||
| - RABBITMQ\_PASSWORD: | ||
| The password used to authenticate to the RabbitMQ message broker. Only required if | ||
| RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _format_: string |
despadam
reviewed
Jan 8, 2025
| @@ -280,7 +280,7 @@ before running the backend. A basic rabbitMQ set up in the component-config.loca | |||
|
|
|||
| ``` | |||
| The exchange and the binding key must be named `jobs.write` and `jobqueue` respectively, the queue name can take any value. | |||
| The backend expects and exchange called `jobs.write` to publish jobs messages to bound with that key. | |||
| The backend expects an exchange called `jobs.write` to publish jobs messages to bound with that key. | |||
There was a problem hiding this comment.
Is the Connecting Scicat to RabbitMQ section still needed?
refactored job tests update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for jobconfig.json file